provider Snapshots GET /api/0/organizations/{organization_id_or_slug}/preprodartifacts/snapshots/{snapshot_id}/
@utdk/sentry /api/0/organizations/{organization_id_or_slug}/preprodartifacts/snapshots/{snapshot_id}/
Retrieve Snapshot details
Retrieve full details for a snapshot, including categorized image lists and comparison status. When a comparison exists, images are categorized into `changed`, `added`, `removed`, `renamed`, `unchanged`, `errored`, and `skipped` lists with counts. Without a comparison, only the `images` list is populated. Use `compact_metadata=1` to strip image objects down to `display_name`, `image_file_name`, `group`, and `description` only. This endpoint requires a bearer token with `project:read` access.
organization_id_or_slug path required
The ID or slug of the organization the resource belongs to.
string
snapshot_id path required
The ID of the snapshot.
string
compact_metadata query
Set to '1' or 'true' to strip image metadata to display_name, image_file_name, group, and description only.
string

Try it

Authentication
Configure credentials for API Reference
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

retrieveSnapshotDetails
GET/api/0/organizations/{organization_id_or_slug}/preprodartifacts/snapshots/{snapshot_id}/
Retrieve full details for a snapshot, including categorized image lists and comparison status. When a comparison exists, images are categorized into `changed`, `added`, `removed`, `renamed`, `unchanged`, `errored`, and `skipped` lists with counts. Without a comparison, only the `images` list is populated. Use `compact_metadata=1` to strip image objects down to `display_name`, `image_file_name`, `group`, and `description` only. This endpoint requires a bearer token with `project:read` access.

Parameters

required

The ID or slug of the organization the resource belongs to.

required

The ID of the snapshot.

Set to '1' or 'true' to strip image metadata to display_name, image_file_name, group, and description only.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sentry from '@utdk/sentry';

await sentry.retrieveSnapshotDetails()